<!DOCTYPE HTML>

<html lang="en">
<head>

<title>PersistentTokenBasedRememberMeServices (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="PersistentTokenBasedRememberMeServices (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="PersistentTokenBasedRememberMeServices.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="PersistentTokenBasedRememberMeServices.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="PersistentTokenBasedRememberMeServices.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="PersistentTokenBasedRememberMeServices.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="PersistentTokenBasedRememberMeServices.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="PersistentTokenBasedRememberMeServices.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="PersistentTokenBasedRememberMeServices.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.web.authentication.rememberme</a></div>
<h2 title="Class PersistentTokenBasedRememberMeServices" class="title">Class PersistentTokenBasedRememberMeServices</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="AbstractRememberMeServices.html" title="class in org.springframework.security.web.authentication.rememberme">org.springframework.security.web.authentication.rememberme.AbstractRememberMeServices</a></li>
<li>
<ul class="inheritance">
<li>org.springframework.security.web.authentication.rememberme.PersistentTokenBasedRememberMeServices</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>org.springframework.beans.factory.Aware</code>, <code>org.springframework.beans.factory.InitializingBean</code>, <code>org.springframework.context.MessageSourceAware</code>, <code><a href="../logout/LogoutHandler.html" title="interface in org.springframework.security.web.authentication.logout">LogoutHandler</a></code>, <code><a href="../RememberMeServices.html" title="interface in org.springframework.security.web.authentication">RememberMeServices</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">PersistentTokenBasedRememberMeServices</span>
extends <a href="AbstractRememberMeServices.html" title="class in org.springframework.security.web.authentication.rememberme">AbstractRememberMeServices</a></pre>
<div class="block"><a href="../RememberMeServices.html" title="interface in org.springframework.security.web.authentication"><code>RememberMeServices</code></a> implementation based on Barry Jaspan's
<a href="http://jaspan.com/improved_persistent_login_cookie_best_practice">Improved
Persistent Login Cookie Best Practice</a>.
There is a slight modification to the described approach, in that the username is not
stored as part of the cookie but obtained from the persistent store via an
implementation of <a href="PersistentTokenRepository.html" title="interface in org.springframework.security.web.authentication.rememberme"><code>PersistentTokenRepository</code></a>. The latter should place a unique
constraint on the series identifier, so that it is impossible for the same identifier
to be allocated to two different users.
<p>
User management such as changing passwords, removing users and setting user status
should be combined with maintenance of the user's persistent tokens.
</p>
<p>
Note that while this class will use the date a token was created to check whether a
presented cookie is older than the configured <tt>tokenValiditySeconds</tt> property
and deny authentication in this case, it will not delete these tokens from storage. A
suitable batch process should be run periodically to remove expired tokens from the
database.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">

</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PersistentTokenBasedRememberMeServices.html#DEFAULT_SERIES_LENGTH">DEFAULT_SERIES_LENGTH</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PersistentTokenBasedRememberMeServices.html#DEFAULT_TOKEN_LENGTH">DEFAULT_TOKEN_LENGTH</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.springframework.security.web.authentication.rememberme.AbstractRememberMeServices">

</a>
<h3>Fields inherited from class&nbsp;org.springframework.security.web.authentication.rememberme.<a href="AbstractRememberMeServices.html" title="class in org.springframework.security.web.authentication.rememberme">AbstractRememberMeServices</a></h3>
<code><a href="AbstractRememberMeServices.html#DEFAULT_PARAMETER">DEFAULT_PARAMETER</a>, <a href="AbstractRememberMeServices.html#logger">logger</a>, <a href="AbstractRememberMeServices.html#messages">messages</a>, <a href="AbstractRememberMeServices.html#SPRING_SECURITY_REMEMBER_ME_COOKIE_KEY">SPRING_SECURITY_REMEMBER_ME_COOKIE_KEY</a>, <a href="AbstractRememberMeServices.html#TWO_WEEKS_S">TWO_WEEKS_S</a></code></li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">

</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="PersistentTokenBasedRememberMeServices.html#%3Cinit%3E(java.lang.String,org.springframework.security.core.userdetails.UserDetailsService,org.springframework.security.web.authentication.rememberme.PersistentTokenRepository)">PersistentTokenBasedRememberMeServices</a></span>&#8203;(java.lang.String&nbsp;key,
<a href="../../../core/userdetails/UserDetailsService.html" title="interface in org.springframework.security.core.userdetails">UserDetailsService</a>&nbsp;userDetailsService,
<a href="PersistentTokenRepository.html" title="interface in org.springframework.security.web.authentication.rememberme">PersistentTokenRepository</a>&nbsp;tokenRepository)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PersistentTokenBasedRememberMeServices.html#generateSeriesData()">generateSeriesData</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PersistentTokenBasedRememberMeServices.html#generateTokenData()">generateTokenData</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PersistentTokenBasedRememberMeServices.html#logout(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">logout</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response,
<a href="../../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&nbsp;authentication)</code></th>
<td class="colLast">
<div class="block">Implementation of <code>LogoutHandler</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PersistentTokenBasedRememberMeServices.html#onLoginSuccess(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">onLoginSuccess</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response,
<a href="../../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&nbsp;successfulAuthentication)</code></th>
<td class="colLast">
<div class="block">Creates a new persistent login token with a new series number, stores the data in
the persistent token repository and adds the corresponding cookie to the response.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected <a href="../../../core/userdetails/UserDetails.html" title="interface in org.springframework.security.core.userdetails">UserDetails</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PersistentTokenBasedRememberMeServices.html#processAutoLoginCookie(java.lang.String%5B%5D,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">processAutoLoginCookie</a></span>&#8203;(java.lang.String[]&nbsp;cookieTokens,
javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code></th>
<td class="colLast">
<div class="block">Locates the presented cookie data in the token repository, using the series id.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PersistentTokenBasedRememberMeServices.html#setSeriesLength(int)">setSeriesLength</a></span>&#8203;(int&nbsp;seriesLength)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PersistentTokenBasedRememberMeServices.html#setTokenLength(int)">setTokenLength</a></span>&#8203;(int&nbsp;tokenLength)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PersistentTokenBasedRememberMeServices.html#setTokenValiditySeconds(int)">setTokenValiditySeconds</a></span>&#8203;(int&nbsp;tokenValiditySeconds)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.security.web.authentication.rememberme.AbstractRememberMeServices">

</a>
<h3>Methods inherited from class&nbsp;org.springframework.security.web.authentication.rememberme.<a href="AbstractRememberMeServices.html" title="class in org.springframework.security.web.authentication.rememberme">AbstractRememberMeServices</a></h3>
<code><a href="AbstractRememberMeServices.html#afterPropertiesSet()">afterPropertiesSet</a>, <a href="AbstractRememberMeServices.html#autoLogin(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">autoLogin</a>, <a href="AbstractRememberMeServices.html#cancelCookie(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">cancelCookie</a>, <a href="AbstractRememberMeServices.html#createSuccessfulAuthentication(javax.servlet.http.HttpServletRequest,org.springframework.security.core.userdetails.UserDetails)">createSuccessfulAuthentication</a>, <a href="AbstractRememberMeServices.html#decodeCookie(java.lang.String)">decodeCookie</a>, <a href="AbstractRememberMeServices.html#encodeCookie(java.lang.String%5B%5D)">encodeCookie</a>, <a href="AbstractRememberMeServices.html#extractRememberMeCookie(javax.servlet.http.HttpServletRequest)">extractRememberMeCookie</a>, <a href="AbstractRememberMeServices.html#getAuthenticationDetailsSource()">getAuthenticationDetailsSource</a>, <a href="AbstractRememberMeServices.html#getCookieName()">getCookieName</a>, <a href="AbstractRememberMeServices.html#getKey()">getKey</a>, <a href="AbstractRememberMeServices.html#getParameter()">getParameter</a>, <a href="AbstractRememberMeServices.html#getTokenValiditySeconds()">getTokenValiditySeconds</a>, <a href="AbstractRememberMeServices.html#getUserDetailsService()">getUserDetailsService</a>, <a href="AbstractRememberMeServices.html#loginFail(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">loginFail</a>, <a href="AbstractRememberMeServices.html#loginSuccess(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">loginSuccess</a>, <a href="AbstractRememberMeServices.html#onLoginFail(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">onLoginFail</a>, <a href="AbstractRememberMeServices.html#rememberMeRequested(javax.servlet.http.HttpServletRequest,java.lang.String)">rememberMeRequested</a>, <a href="AbstractRememberMeServices.html#setAlwaysRemember(boolean)">setAlwaysRemember</a>, <a href="AbstractRememberMeServices.html#setAuthenticationDetailsSource(org.springframework.security.authentication.AuthenticationDetailsSource)">setAuthenticationDetailsSource</a>, <a href="AbstractRememberMeServices.html#setAuthoritiesMapper(org.springframework.security.core.authority.mapping.GrantedAuthoritiesMapper)">setAuthoritiesMapper</a>, <a href="AbstractRememberMeServices.html#setCookie(java.lang.String%5B%5D,int,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">setCookie</a>, <a href="AbstractRememberMeServices.html#setCookieDomain(java.lang.String)">setCookieDomain</a>, <a href="AbstractRememberMeServices.html#setCookieName(java.lang.String)">setCookieName</a>, <a href="AbstractRememberMeServices.html#setMessageSource(org.springframework.context.MessageSource)">setMessageSource</a>, <a href="AbstractRememberMeServices.html#setParameter(java.lang.String)">setParameter</a>, <a href="AbstractRememberMeServices.html#setUserDetailsChecker(org.springframework.security.core.userdetails.UserDetailsChecker)">setUserDetailsChecker</a>, <a href="AbstractRememberMeServices.html#setUseSecureCookie(boolean)">setUseSecureCookie</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">

</a>
<h3>Field Detail</h3>
<a id="DEFAULT_SERIES_LENGTH">

</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_SERIES_LENGTH</h4>
<pre>public static final&nbsp;int DEFAULT_SERIES_LENGTH</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.springframework.security.web.authentication.rememberme.PersistentTokenBasedRememberMeServices.DEFAULT_SERIES_LENGTH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_TOKEN_LENGTH">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_TOKEN_LENGTH</h4>
<pre>public static final&nbsp;int DEFAULT_TOKEN_LENGTH</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.springframework.security.web.authentication.rememberme.PersistentTokenBasedRememberMeServices.DEFAULT_TOKEN_LENGTH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">

</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.lang.String,org.springframework.security.core.userdetails.UserDetailsService,org.springframework.security.web.authentication.rememberme.PersistentTokenRepository)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PersistentTokenBasedRememberMeServices</h4>
<pre>public&nbsp;PersistentTokenBasedRememberMeServices&#8203;(java.lang.String&nbsp;key,
                                              <a href="../../../core/userdetails/UserDetailsService.html" title="interface in org.springframework.security.core.userdetails">UserDetailsService</a>&nbsp;userDetailsService,
                                              <a href="PersistentTokenRepository.html" title="interface in org.springframework.security.web.authentication.rememberme">PersistentTokenRepository</a>&nbsp;tokenRepository)</pre>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="processAutoLoginCookie(java.lang.String[],javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>processAutoLoginCookie</h4>
<pre class="methodSignature">protected&nbsp;<a href="../../../core/userdetails/UserDetails.html" title="interface in org.springframework.security.core.userdetails">UserDetails</a>&nbsp;processAutoLoginCookie&#8203;(java.lang.String[]&nbsp;cookieTokens,
                                             javax.servlet.http.HttpServletRequest&nbsp;request,
                                             javax.servlet.http.HttpServletResponse&nbsp;response)</pre>
<div class="block">Locates the presented cookie data in the token repository, using the series id. If
the data compares successfully with that in the persistent store, a new token is
generated and stored with the same series. The corresponding cookie value is set on
the response.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AbstractRememberMeServices.html#processAutoLoginCookie(java.lang.String%5B%5D,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">processAutoLoginCookie</a></code>&nbsp;in class&nbsp;<code><a href="AbstractRememberMeServices.html" title="class in org.springframework.security.web.authentication.rememberme">AbstractRememberMeServices</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cookieTokens</code> - the series and token values</dd>
<dd><code>request</code> - the request</dd>
<dd><code>response</code> - the response, to allow the cookie to be modified if required.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the UserDetails for the corresponding user account if the cookie was
validated successfully.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="RememberMeAuthenticationException.html" title="class in org.springframework.security.web.authentication.rememberme">RememberMeAuthenticationException</a></code> - if there is no stored token corresponding
to the submitted cookie, or if the token in the persistent store has expired.</dd>
<dd><code><a href="InvalidCookieException.html" title="class in org.springframework.security.web.authentication.rememberme">InvalidCookieException</a></code> - if the cookie doesn't have two tokens as expected.</dd>
<dd><code><a href="CookieTheftException.html" title="class in org.springframework.security.web.authentication.rememberme">CookieTheftException</a></code> - if a presented series value is found, but the stored
token is different from the one presented.</dd>
</dl>
</li>
</ul>
<a id="onLoginSuccess(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>onLoginSuccess</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;onLoginSuccess&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
                              javax.servlet.http.HttpServletResponse&nbsp;response,
                              <a href="../../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&nbsp;successfulAuthentication)</pre>
<div class="block">Creates a new persistent login token with a new series number, stores the data in
the persistent token repository and adds the corresponding cookie to the response.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AbstractRememberMeServices.html#onLoginSuccess(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">onLoginSuccess</a></code>&nbsp;in class&nbsp;<code><a href="AbstractRememberMeServices.html" title="class in org.springframework.security.web.authentication.rememberme">AbstractRememberMeServices</a></code></dd>
</dl>
</li>
</ul>
<a id="logout(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>logout</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;logout&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
                   javax.servlet.http.HttpServletResponse&nbsp;response,
                   <a href="../../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&nbsp;authentication)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="AbstractRememberMeServices.html#logout(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">AbstractRememberMeServices</a></code></span></div>
<div class="block">Implementation of <code>LogoutHandler</code>. Default behaviour is to call
<code>cancelCookie()</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../logout/LogoutHandler.html#logout(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">logout</a></code>&nbsp;in interface&nbsp;<code><a href="../logout/LogoutHandler.html" title="interface in org.springframework.security.web.authentication.logout">LogoutHandler</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractRememberMeServices.html#logout(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">logout</a></code>&nbsp;in class&nbsp;<code><a href="AbstractRememberMeServices.html" title="class in org.springframework.security.web.authentication.rememberme">AbstractRememberMeServices</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the HTTP request</dd>
<dd><code>response</code> - the HTTP response</dd>
<dd><code>authentication</code> - the current principal details</dd>
</dl>
</li>
</ul>
<a id="generateSeriesData()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>generateSeriesData</h4>
<pre class="methodSignature">protected&nbsp;java.lang.String&nbsp;generateSeriesData()</pre>
</li>
</ul>
<a id="generateTokenData()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>generateTokenData</h4>
<pre class="methodSignature">protected&nbsp;java.lang.String&nbsp;generateTokenData()</pre>
</li>
</ul>
<a id="setSeriesLength(int)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setSeriesLength</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSeriesLength&#8203;(int&nbsp;seriesLength)</pre>
</li>
</ul>
<a id="setTokenLength(int)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setTokenLength</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setTokenLength&#8203;(int&nbsp;tokenLength)</pre>
</li>
</ul>
<a id="setTokenValiditySeconds(int)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setTokenValiditySeconds</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setTokenValiditySeconds&#8203;(int&nbsp;tokenValiditySeconds)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractRememberMeServices.html#setTokenValiditySeconds(int)">setTokenValiditySeconds</a></code>&nbsp;in class&nbsp;<code><a href="AbstractRememberMeServices.html" title="class in org.springframework.security.web.authentication.rememberme">AbstractRememberMeServices</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="PersistentTokenBasedRememberMeServices.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="PersistentTokenBasedRememberMeServices.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="PersistentTokenBasedRememberMeServices.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="PersistentTokenBasedRememberMeServices.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="PersistentTokenBasedRememberMeServices.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="PersistentTokenBasedRememberMeServices.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="PersistentTokenBasedRememberMeServices.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040cf0e9fd7980c","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
